✨ Make the anonymous field of the groupName marker optional #1000

twz123 · 2024-07-04T15:24:41Z

Upstream introduced the use of empty groupName markers in kubernetes/kubernetes#125162. This breaks groupName parsing because its field is non-optional. Add an additional mustOptional function that takes anonymous field definitions and turns them into optional ones.

k8s-ci-robot · 2024-07-04T15:24:51Z

Welcome @twz123!

It looks like this is your first PR to kubernetes-sigs/controller-tools 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-tools has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-07-04T15:24:52Z

Hi @twz123. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

sbueringer · 2024-07-11T09:53:24Z

/ok-to-test

sbueringer · 2024-07-11T09:59:14Z

@twz123 Implementation looks good. Let's please add some test coverage. (I think somewhere below pkg/crd/testdata something that uses groupName=)

pkg/crd/markers/package.go

Upstream introduced the use of empty groupName markers in k/k PR 125162. This breaks groupName parsing because its field is non-optional. Add an additional mustOptional function that takes anonymous field definitions and turns them into optional ones. Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>

twz123 · 2024-07-11T15:20:52Z

@twz123 Implementation looks good. Let's please add some test coverage. (I think somewhere below pkg/crd/testdata something that uses groupName=)

Done!

sbueringer · 2024-07-15T09:32:25Z

/retest

sbueringer · 2024-07-15T09:47:11Z

pkg/crd/markers/package.go

@@ -22,7 +22,7 @@ import (

 func init() {
 	AllDefinitions = append(AllDefinitions,
-		must(markers.MakeDefinition("groupName", markers.DescribesPackage, "")).


@sttts Does it sound reasonable for you to just adjust the marker here to accept an "empty" groupName marker ("// +groupName=") without any additional handling for the empty string?

Context: Without this PR controller-gen fails like this now (with API types that use types from k8s.io/api@v0.31.0-alpha.3)

/home/prow/go/pkg/mod/k8s.io/api@v0.31.0-alpha.3/core/v1/doc.go:21:1: missing argument "" (at )
/home/prow/go/pkg/mod/k8s.io/api@v0.31.0-alpha.3/core/v1/doc.go:21:1: missing argument "" (at )
https://prow.k8s.io/view/gs/kubernetes-jenkins/pr-logs/pull/kubernetes-sigs_cluster-api/10803/pull-cluster-api-verify-main/1811372226943913984

without any additional handling for the empty string?

This is about embedding corev1 types in some CRD, right? So the groupName of the corev1 package does not really play a role for the CRD, does it? So yes, I think just parsing it without falling over, and then ignoring it outside of actual CRD API package sounds right.

This is about embedding corev1 types in some CRD, right?

Yes exactly

So the groupName of the corev1 package does not really play a role for the CRD, does it?

This is my understanding, yes

I'm not sure if anyone is doing it, but theoretically folks could use controller-gen to generate CRDs for types of the k/k core API. In that case they would end up with an empty group in the CRD with groupName= (see the test in this PR: pkg/crd/testdata/testdata._cronjobs.yaml)

Not sure which group would be correct in this (probably hypothetical) case. But folks could just specify whatever group they want via groupName, so I assume it's fine

Okay, thx!

I think then let's do the same in controller-gen for now. We can still modify this behavior later (or offer some additional markers) if people want something else for CRD generation for the core API group

@twz123 WDYT about handling the empty group here:

controller-tools/pkg/crd/spec.go

Line 73 in b370e9b

Name: defaultPlural + "." + groupKind.Group,

to use "core" for the CRD name suffix if .Group is an empty string?

The current name generated in the test case also seems to be invalid:

The CustomResourceDefinition "cronjobs." is invalid: * metadata.name: Invalid value: "cronjobs.": a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character (e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*') * metadata.name: Invalid value: "cronjobs.": must be spec.names.plural+"."+spec.group

@sttts I was trying to deploy a CRD with name & group like this, but I'm getting these errors with a regular kube-apiserver (kindest/node:v1.30.0)

The CustomResourceDefinition "cronjobs.core" is invalid: * metadata.name: Invalid value: "cronjobs.core": must be spec.names.plural+"."+spec.group * spec.group: Required value

CRD:

apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: (devel) name: cronjobs.core spec: group: "" names: kind: CronJob listKind: CronJobList plural: cronjobs singular: cronjob scope: Namespaced ...

In Kube does is not allowed today. You cannot mix native and CRD api groups.

sbueringer · 2024-07-15T10:00:43Z

/lgtm

k8s-ci-robot · 2024-07-15T10:00:49Z

LGTM label has been added.

Git tree hash: 98d1e914f29072f51bc71936ebe0a015b8994ee9

sbueringer · 2024-07-16T08:58:00Z

Let's go ahead with this fix to unblock folks that just want to generate CRD for "non-core" apiGroups. I think this should be 99,9% of controller-gen users. Let's see if we want to do a follow-up based on the discussion here: #1000 (comment)

sbueringer · 2024-07-16T08:58:02Z

/approve

k8s-ci-robot · 2024-07-16T08:58:16Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer, twz123

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [sbueringer]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 4, 2024

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 4, 2024

k8s-ci-robot requested review from joelanford and vincepri July 4, 2024 15:24

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 4, 2024

twz123 changed the title ~~✨ Make the anonymous value of the groupName marker optional~~ ✨ Make the anonymous field of the groupName marker optional Jul 4, 2024

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 11, 2024

sbueringer mentioned this pull request Jul 11, 2024

✨ Bump to controller-runtime v0.19 & controller-tools v0.16 kubernetes-sigs/cluster-api#10803

Merged

sbueringer reviewed Jul 11, 2024

View reviewed changes

pkg/crd/markers/package.go Show resolved Hide resolved

twz123 force-pushed the optional-groupname branch from 31c93d2 to 7c1db6b Compare July 11, 2024 15:17

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 11, 2024

sbueringer reviewed Jul 15, 2024

View reviewed changes

k8s-ci-robot assigned sbueringer Jul 15, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 15, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 16, 2024

k8s-ci-robot merged commit b1ff5ff into kubernetes-sigs:master Jul 16, 2024
7 checks passed

twz123 deleted the optional-groupname branch July 17, 2024 18:22

sbueringer mentioned this pull request Aug 2, 2024

Failed to generate manifest for k8s.io/api@v0.31.0-rc.0 #1017

Closed

sbueringer mentioned this pull request Aug 21, 2024

🌱 Controller-runtime v0.19.0 & Controller-tools v0.16.1 vmware-tanzu/vm-operator#675

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Make the anonymous field of the groupName marker optional #1000

✨ Make the anonymous field of the groupName marker optional #1000

twz123 commented Jul 4, 2024

k8s-ci-robot commented Jul 4, 2024

k8s-ci-robot commented Jul 4, 2024

sbueringer commented Jul 11, 2024

sbueringer commented Jul 11, 2024

twz123 commented Jul 11, 2024

sbueringer commented Jul 15, 2024

sbueringer Jul 15, 2024 •

edited

Loading

sbueringer Jul 15, 2024

sttts Jul 15, 2024

sbueringer Jul 15, 2024

sbueringer Jul 15, 2024 •

edited

Loading

sbueringer Jul 15, 2024

sbueringer Jul 15, 2024

sbueringer Jul 15, 2024

sbueringer Jul 16, 2024

sttts Jul 16, 2024

sbueringer commented Jul 15, 2024

k8s-ci-robot commented Jul 15, 2024

sbueringer commented Jul 16, 2024

sbueringer commented Jul 16, 2024

k8s-ci-robot commented Jul 16, 2024

✨ Make the anonymous field of the groupName marker optional #1000

✨ Make the anonymous field of the groupName marker optional #1000

Conversation

twz123 commented Jul 4, 2024

k8s-ci-robot commented Jul 4, 2024

k8s-ci-robot commented Jul 4, 2024

sbueringer commented Jul 11, 2024

sbueringer commented Jul 11, 2024

twz123 commented Jul 11, 2024

sbueringer commented Jul 15, 2024

sbueringer Jul 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbueringer Jul 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbueringer commented Jul 15, 2024

k8s-ci-robot commented Jul 15, 2024

sbueringer commented Jul 16, 2024

sbueringer commented Jul 16, 2024

k8s-ci-robot commented Jul 16, 2024

sbueringer Jul 15, 2024 •

edited

Loading

sbueringer Jul 15, 2024 •

edited

Loading